<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class PhormWidget</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class PhormWidget</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
							<a href="#sec-descendents">Descendents</a>
			|													<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">PhormWidget</p>
<p class="description"><p>The base class of all HTML form widgets.</p></p>
	<ul class="tags">
				<li><span class="field">author:</span> Jeff Ober</li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_widgets.php.html">/widgets.php</a> (line <span class="field">20</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>

	<a name="sec-descendents"></a>
	<div class="info-box">
		<div class="info-box-title">Direct descendents</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
			<span class="disabled">Descendents</span>
			|															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
								</div>
		<div class="info-box-body">
			<table cellpadding="2" cellspacing="0" class="class-table">
				<tr>
					<th class="class-table-header">Class</th>
					<th class="class-table-header">Description</th>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../Widgets/FileWidget.html">FileWidget</a></td>
					<td>
											FileWidget
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../Widgets/CharWidget.html">CharWidget</a></td>
					<td>
											CharWidget
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../Widgets/HiddenWidget.html">HiddenWidget</a></td>
					<td>
											HiddenWidget
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../Widgets/PasswordWidget.html">PasswordWidget</a></td>
					<td>
											PasswordWidget
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../Widgets/TextWidget.html">TextWidget</a></td>
					<td>
											TextWidget
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../Widgets/RadioWidget.html">RadioWidget</a></td>
					<td>
											RadioWidget
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../Widgets/CheckboxWidget.html">CheckboxWidget</a></td>
					<td>
											CheckboxWidget
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../Widgets/OptionGroupWidget.html">OptionGroupWidget</a></td>
					<td>
											OptionGroupWidget
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../Widgets/SelectWidget.html">SelectWidget</a></td>
					<td>
											SelectWidget
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../Widgets/MultiSelectWidget.html">MultiSelectWidget</a></td>
					<td>
											SelectWidget
										</td>
				</tr>
							</table>
		</div>
	</div>



	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
												<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																														
				<div class="method-definition">
											<span class="method-result">a</span>
										<a href="#clean_string" title="details" class="method-name">clean_string</a>
											(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$str</span>)
									</div>
														
				<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#html" title="details" class="method-name">html</a>
											(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$value</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$attributes</span> = <span class="var-default">array()</span>])
									</div>
														
				<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#serialize" title="details" class="method-name">serialize</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$attributes</span> = <span class="var-default">array()</span>])
									</div>
														
				<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#serialize_attributes" title="details" class="method-name">serialize_attributes</a>
											([<span class="var-type"></span>&nbsp;<span class="var-name">$attributes</span> = <span class="var-default">array()</span>])
									</div>
											</div>
		</div>
	</div>		

	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
																<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>
<a name="methodclean_string" id="clean_string"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">clean_string</span> (line <span class="line-number">54</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Casts a value to a string and encodes it for HTML output.</p>
	<ul class="tags">
				<li><span class="field">return:</span> decoded string</li>
				<li><span class="field">author:</span> Jeff Ober</li>
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">a</span>
		<span class="method-name">
			clean_string
		</span>
					(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$str</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$str</span>			</li>
				</ul>
		
			
	</div>
<a name="methodhtml" id="html"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">html</span> (line <span class="line-number">66</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the field as serialized HTML.</p>
	<ul class="tags">
				<li><span class="field">return:</span> the serialized HTML</li>
				<li><span class="field">author:</span> Jeff Ober</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			html
		</span>
					(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$value</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$attributes</span> = <span class="var-default">array()</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$value</span><span class="var-description">: the form widget's value attribute</span>			</li>
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$attributes</span><span class="var-description">: key=&gt;value pairs corresponding to HTML attributes' name=&gt;value</span>			</li>
				</ul>
		
			
			<hr class="separator" />
		<div class="notes">Redefined in descendants as:</div>
		<ul class="redefinitions">
					<li>
				<a href="../Widgets/OptionGroupWidget.html#methodhtml">OptionGroupWidget::html()</a>
							</li>
					<li>
				<a href="../Widgets/MultiSelectWidget.html#methodhtml">MultiSelectWidget::html()</a>
							</li>
				</ul>
	</div>
<a name="methodserialize" id="serialize"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">serialize</span> (line <span class="line-number">43</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Serializes the widget as an HTML form input.</p>
	<ul class="tags">
				<li><span class="field">return:</span> the serialized HTML</li>
				<li><span class="field">author:</span> Jeff Ober</li>
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			serialize
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$attributes</span> = <span class="var-default">array()</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$value</span><span class="var-description">: the form widget's value</span>			</li>
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$attributes</span><span class="var-description">: key=&gt;value pairs corresponding to HTML attributes' name=&gt;value</span>			</li>
				</ul>
		
			
			<hr class="separator" />
		<div class="notes">Redefined in descendants as:</div>
		<ul class="redefinitions">
					<li>
				<a href="../Widgets/FileWidget.html#methodserialize">FileWidget::serialize()</a>
								: Returns the field as serialized HTML.
							</li>
					<li>
				<a href="../Widgets/CharWidget.html#methodserialize">CharWidget::serialize()</a>
								: Returns the field as serialized HTML.
							</li>
					<li>
				<a href="../Widgets/HiddenWidget.html#methodserialize">HiddenWidget::serialize()</a>
								: Returns the field as serialized HTML.
							</li>
					<li>
				<a href="../Widgets/PasswordWidget.html#methodserialize">PasswordWidget::serialize()</a>
								: Returns the field as serialized HTML.
							</li>
					<li>
				<a href="../Widgets/TextWidget.html#methodserialize">TextWidget::serialize()</a>
								: Returns the field as serialized HTML.
							</li>
					<li>
				<a href="../Widgets/RadioWidget.html#methodserialize">RadioWidget::serialize()</a>
								: Returns the field as serialized HTML.
							</li>
					<li>
				<a href="../Widgets/CheckboxWidget.html#methodserialize">CheckboxWidget::serialize()</a>
								: Returns the field as serialized HTML.
							</li>
					<li>
				<a href="../Widgets/OptionGroupWidget.html#methodserialize">OptionGroupWidget::serialize()</a>
								: Returns the field as serialized HTML.
							</li>
					<li>
				<a href="../Widgets/SelectWidget.html#methodserialize">SelectWidget::serialize()</a>
								: Returns the field as serialized HTML.
							</li>
					<li>
				<a href="../Widgets/MultiSelectWidget.html#methodserialize">MultiSelectWidget::serialize()</a>
								: Returns the field as serialized HTML.
							</li>
				</ul>
	</div>
<a name="methodserialize_attributes" id="serialize_attributes"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">serialize_attributes</span> (line <span class="line-number">28</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Serializes an array of key=&gt;value pairs as an HTML attributes string.</p>
	<ul class="tags">
				<li><span class="field">return:</span> the serialized HTML</li>
				<li><span class="field">author:</span> Jeff Ober</li>
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			serialize_attributes
		</span>
					([<span class="var-type"></span>&nbsp;<span class="var-name">$attributes</span> = <span class="var-default">array()</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$attributes</span><span class="var-description">: key=&gt;value pairs corresponding to HTML attributes' name=&gt;value</span>			</li>
				</ul>
		
			
	</div>
						
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Mon, 20 Apr 2009 08:29:26 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
	</p>
	</div></body>
</html>